.. _ecmSxCfg_AutoTorq_SetLimit:

ecmSxCfg_AutoTorq_SetLimit
===========================
---------------------------

SYNOPSIS
```````````

.. code-block:: none

    t_success ecmSxCfg_AutoTorq_SetLimit(
        [in] t_i32 NetID, [in] t_i32 Axis, [in] t_ui32 LimitMask, [in] t_f64 HighSpeedLimit, 
        [in] t_f64 LowSpeedLimit, [in] t_i32 TimeLimit,[out]_i32 *ErrCode
        )


DESCRIPTION
```````````````

- 이 함수는 자동토크출력 기능에서의 토크출력 모드를 자동으로 완료하는 완료 조건을
  설정하는 함수입니다.

PARAMETER
```````````

- NetID : Network 번호

\

- Axis : 대상 축 번호

\

- LimitMask : 적용하고자 하는 완료 조건의 종류를 각 비트별로 설정한다. 단, 이 값을 0 으로하면 자동 완료 조건을 설정하지 않게 된다. 
  따라서 그러한 경우에는 ecmSxCfg_AutoTorq_SetEnable() 함수를 통해서만 토크출력모드를 완료할 수 있다. 
  LimitMask 값의 각 비트의 의미는 아래 와 같다. 아래 표에서 “Bit 번호 정의값＂은 
  ComiEcatSdk_Def.h 파일의 EEcmAtrqLimMask 선언문을 참고하기 바랍니다.

.. csv-table:: 
    :widths: 5 10 85
    :header-rows: 1
    :stub-columns: 0


    Bit 번호, Bit 번호 정의값, Meaning
    BIT00, ecmATRQ_LMBIT_HIGHSPD, HighSpeedLimit 의 적용 여부 (0 - 적용안함 / 1 - 적용함)
    BIT01, ecmATRQ_LMBIT_LOWSPD, LowSpeedLimit 의 적용 여부 (0 - 적용안함 / 1 - 적용함)
    BIT02, ecmATRQ_LMBIT_TIME, TimeLimit 의 적용 여부 (0 - 적용안함 / 1 - 적용함)

- HighSpeedLimit : 해당 축의 이송속도의 최대값을 설정한다. 현재 모터의 이송속도(피드백 속도)가 
  여기에서 정의한 값보다 같거나 크게 되면 토크 출력모드를 자동으로 완료합니다.
  단, 이 값의 적용 여부는 LimitMask 매개변수의 bit0 의 설정에 의해서 결정됩니다.

\

- LowSpeedLimit : 해당 축의 이송속도의 최소값을 설정한다. 현재 모터의 이송속도(피드백 속도)가 
  여기에서 정의한 값보다 같거나 작게 되면 토크 출력모드를 자동으로 완료합니다. 
  단, 이 값의 적용 여부는 LimitMask 매개변수의 bit1 의 설정에 의해서 결정됩니다.

\

- TimeLimit: 토크출력 모드의 최대 유지 시간을 설정한다. 토크모드로 전환된 이후에
  여기에서 정의한 시간이 경과되면 토크출력모드를 자동으로 완료합니다. 
  단, 이 값의 적용 여부는 LimitMask 매개변수의 bit2 의 설정에 의해서 결정됩니다.

\

- ErrCode : 이 매개 변수를 통하여 현재의 에러 코드를 반환합니다. 단, 이 매개 변수에
  NULL 을 전달하면 에러 코드를 반환하지 않습니다.


RETURN VALUE
```````````````

이 리턴값은 불 형(Boolean Type) 을 가지고 있습니다.


.. csv-table:: 
    :widths: 15 85
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    0, 함수 수행에 실패 하였음을 의미합니다.
    1, 함수 수행에 성공 하였음을 의미합니다.


.. seealso:: :ref:`ecmSxCfg_AutoTorq_GetLimit`